API Documentation
Classes | Public Member Functions | List of all members
nkWinUi::ListBox Class Reference

A graphical list box. More...

Inheritance diagram for nkWinUi::ListBox:
nkWinUi::Component nkExport::Exportable

Classes

class  Item
 

Public Member Functions

 ListBox ()
 
 ~ListBox ()
 
ItemgetItemFromLabel (const std::string_view &label) const
 
ItemgetItemFromData (void *data) const
 
ItemgetItemFromIndex (unsigned int index) const
 
virtual ItemgetCurrentSelection () const
 
virtual int getCurrentSelectionIndex () const
 
listBoxSelectionCallback getSelectionSpecializedCallback () const
 
unsigned int getItemCount () const
 
void setSelectionSpecializedCallback (listBoxSelectionCallback value)
 
virtual IteminsertItem (const std::string_view &text, void *data)
 
virtual void * deleteItem (const std::string_view &name)
 
virtual void changeItemLabel (const std::string_view &oldText, const std::string_view &newText)
 
void changeItemData (const std::string_view &text, void *newData)
 
virtual bool setSelected (const std::string_view &text)
 
virtual bool setSelectedIndex (unsigned int index)
 
bool setSelectedData (void *data)
 
virtual void clearItems ()
 
virtual void exportIntrospection (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Component
 Component ()
 
virtual ~Component ()
 
LayoutgetLayout () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getArea () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
const char * getComponentName () const
 
bool getVisibility () const
 
virtual const char * getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setArea (nkMaths::Rectangle area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const std::string_view &label)
 
void setComponentName (const std::string_view &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
virtual void updateWindow ()
 
void onSized ()
 
ContextMenucreateContextMenu ()
 
ContextMenugetCurrentContextMenu ()
 
void shutContextMenu ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical list box.

Constructor & Destructor Documentation

◆ ListBox()

nkWinUi::ListBox::ListBox ( )

Constructor.

◆ ~ListBox()

nkWinUi::ListBox::~ListBox ( )

Destructor.

Member Function Documentation

◆ getItemFromLabel()

Item* nkWinUi::ListBox::getItemFromLabel ( const std::string_view &  label) const
Parameters
labelThe label of the item to find.
Returns
The item with requested label if available, nullptr else.

◆ getItemFromData()

Item* nkWinUi::ListBox::getItemFromData ( void *  data) const
Parameters
dataThe data of the item to find.
Returns
The item with requested data if available, nullptr else.

◆ getItemFromIndex()

Item* nkWinUi::ListBox::getItemFromIndex ( unsigned int  index) const
Parameters
indexThe index of the item to find.
Returns
The item with requested index if available, nullptr else.

◆ getCurrentSelection()

virtual Item* nkWinUi::ListBox::getCurrentSelection ( ) const
virtual
Returns
Currently selected item if any, nullptr else.

◆ getCurrentSelectionIndex()

virtual int nkWinUi::ListBox::getCurrentSelectionIndex ( ) const
virtual
Returns
Currently selected item's index if available, -1 else.

◆ getSelectionSpecializedCallback()

listBoxSelectionCallback nkWinUi::ListBox::getSelectionSpecializedCallback ( ) const
Returns
Currently set selection callback.

◆ getItemCount()

unsigned int nkWinUi::ListBox::getItemCount ( ) const
Returns
The item count in the list box.

◆ setSelectionSpecializedCallback()

void nkWinUi::ListBox::setSelectionSpecializedCallback ( listBoxSelectionCallback  value)

Sets the selection callback. Will be called over the one set in the InputSystem.

Parameters
valueThe callback to use.

◆ insertItem()

virtual Item* nkWinUi::ListBox::insertItem ( const std::string_view &  text,
void *  data 
)
virtual

Inserts an item in the list box.

Parameters
textThe label to set for the item.
dataThe user data to attach to the item.
Returns
The freshly created item.
Remarks
The ListBox owns the Item returned.

◆ deleteItem()

virtual void* nkWinUi::ListBox::deleteItem ( const std::string_view &  name)
virtual

Erases an item from the list. Memory linked will be freed.

Parameters
nameThe name of the item to free.

◆ changeItemLabel()

virtual void nkWinUi::ListBox::changeItemLabel ( const std::string_view &  oldText,
const std::string_view &  newText 
)
virtual

Changes a label attached to an existing item.

Parameters
oldTextThe old label of the item to change.
newTextThe new label to set for the item.

◆ changeItemData()

void nkWinUi::ListBox::changeItemData ( const std::string_view &  text,
void *  newData 
)

Changes the data attached to an existing item.

Parameters
textThe label of the item to change.
newDataThe new data to attach to the item.
Remarks
The item won't own the attached user data.

◆ setSelected()

virtual bool nkWinUi::ListBox::setSelected ( const std::string_view &  text)
virtual

Selects an item.

Parameters
textThe label of the item to select.
Returns
If an item could be selected (true) or not (false).

◆ setSelectedIndex()

virtual bool nkWinUi::ListBox::setSelectedIndex ( unsigned int  index)
virtual

Selects an item.

Parameters
indexThe index of the item to select.
Returns
If an item could be selected (true) or not (false).

◆ setSelectedData()

bool nkWinUi::ListBox::setSelectedData ( void *  data)

Selects an item.

Parameters
dataThe attached data the item to select has.
Returns
If an item could be selected (true) or not (false).

◆ clearItems()

virtual void nkWinUi::ListBox::clearItems ( )
virtual

Clears all items in the list box. Memory will be freed.

◆ exportIntrospection()

virtual void nkWinUi::ListBox::exportIntrospection ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

virtual void nkWinUi::ListBox::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: